getAppointment

getAppointment

Header Parameters

authorization string required

authorization

application/json

Request Body required

request

appointmentKey string
appointmentUUID string
dealerDepartmentUuidList string[]
dealerUuid string
requesterUserUuid string

Responses

• 200
• 201
• 401
• 403
• 404

---

OK

application/json

Schema

Example (from schema)

---

Schema

error object
code string
description string
metadata object
property name* string
serviceAppointment object
appointmentKey string
appointmentType string
Possible values: [MOBILE_SERVICE, REGULAR_SERVICE]
assignedUser object
departmentUuid string
isMobileServiceTechnician boolean
isValid boolean
userUuid string
createdByUser object
departmentUuid string
isMobileServiceTechnician boolean
isValid boolean
userUuid string
createdTimeStamp date-time
customerUUID string
customerVehicleUUID string
dealerUUID string
destinationAddress string
destinationLatitude double
destinationLongitude double
emailPreference boolean
internalNotes string
lastMileage string
platform string
Possible values: [DEALER_APP, WEB, MOBILE_APP, DMS, TRANSPORTATION_EVENTS_CONSUMER]
preferredDate string
publicNotes string
quickOpList object[]
Array [
description string
laborOpCode string
opCodeDuration string
opCodeName string
quickOpLiteUUID string
totalPrice string
]
serviceAdvisor object
departmentUuid string
isMobileServiceTechnician boolean
isValid boolean
userUuid string
serviceEndTime string
serviceStartTime string
sprinterVehicleUUID string
status string
Possible values: [PENDING_APPROVAL, SCHEDULED, TRIP_IN_PROGRESS, TECHNICIAN_ARRIVED, SERVICE_IN_PROGRESS, SERVICE_COMPLETED, CANCELLED, COMPLETED, DECLINED]
textPreference boolean
uuid string
statusCode int32
warnings object[]
Array [
code string
description string
]

{
  "error": {
    "code": "string",
    "description": "string",
    "metadata": {}
  },
  "serviceAppointment": {
    "appointmentKey": "string",
    "appointmentType": "MOBILE_SERVICE",
    "assignedUser": {
      "departmentUuid": "string",
      "isMobileServiceTechnician": true,
      "isValid": true,
      "userUuid": "string"
    },
    "createdByUser": {
      "departmentUuid": "string",
      "isMobileServiceTechnician": true,
      "isValid": true,
      "userUuid": "string"
    },
    "createdTimeStamp": "2024-09-05T08:17:28.245Z",
    "customerUUID": "string",
    "customerVehicleUUID": "string",
    "dealerUUID": "string",
    "destinationAddress": "string",
    "destinationLatitude": 0,
    "destinationLongitude": 0,
    "emailPreference": true,
    "internalNotes": "string",
    "lastMileage": "string",
    "platform": "DEALER_APP",
    "preferredDate": "string",
    "publicNotes": "string",
    "quickOpList": [
      {
        "description": "string",
        "laborOpCode": "string",
        "opCodeDuration": "string",
        "opCodeName": "string",
        "quickOpLiteUUID": "string",
        "totalPrice": "string"
      }
    ],
    "serviceAdvisor": {
      "departmentUuid": "string",
      "isMobileServiceTechnician": true,
      "isValid": true,
      "userUuid": "string"
    },
    "serviceEndTime": "string",
    "serviceStartTime": "string",
    "sprinterVehicleUUID": "string",
    "status": "PENDING_APPROVAL",
    "textPreference": true,
    "uuid": "string"
  },
  "statusCode": 0,
  "warnings": [
    {
      "code": "string",
      "description": "string"
    }
  ]
}

Created

Unauthorized

Forbidden

Not Found

Loading...